home *** CD-ROM | disk | FTP | other *** search
/ Programming Languages Suite / ProgramD2.iso / T U R B O Language / Turbo C v2.0 / THELP.DOC < prev    next >
Text File  |  1988-08-29  |  13KB  |  335 lines
  1.                       TURBO HELP UTILITY
  2.                       ------------------
  3.  
  4. This file explains how to use THELP.COM. THELP is a
  5. memory-resident utility that provides online help for Turbo
  6. Pascal and Turbo C. If you are using Turbo Debugger, for
  7. example, you can load THELP, then run the debugger and get
  8. online help for Pascal or C while you are debugging.
  9.  
  10.  
  11. Table of Contents
  12. -----------------
  13. 1.  Starting THELP
  14. 2.  Command-line Options Summary
  15. 3.  Detailed Explanation of Keys Used When THELP is Active
  16. 4.  Detailed Explanation of Command line Options
  17.  
  18.  
  19. 1.  Starting THELP
  20. ------------------
  21.  
  22. Load THELP at the DOS command line simply by typing THELP.
  23. Make sure the Turbo help file (TURBO.HLP for Turbo Pascal,
  24. TCHELP.TCH for TURBO C) is in the current directory or use the /F
  25. command line option described below.
  26.  
  27.  
  28. Memory Usage   - THELP requires about 8K bytes (+ 32K swap file);
  29.                  40K with no swapping.
  30.  
  31. Default hotkey - The default hotkey is Numeric-Keypad-5 (scan
  32.                  code 4ch, shift state 00h).
  33.  
  34. Paste speed    - The default pasting speed is FAST. You'll have
  35.                  to experiment if it pastes too quickly for your
  36.                  editor. Note that you should turn off autoindent
  37.                  in the integrated environment before using the
  38.                  paste feature (Ctrl-Q I toggles autoindent).
  39.  
  40. If you are using SideKick Plus or SideKick 1.x, make sure you
  41. load THELP before you load SideKick.
  42.  
  43.  
  44. 2. Command-line Options Summary
  45. -------------------------------
  46.  
  47.   USAGE:  THELP [options]
  48.  
  49. Here is a summary of the command line options. If you use more
  50. than one option, they must be separated by spaces.
  51.  
  52.   /B        Use BIOS for video
  53.   /C#xx     Select color: #=color number, xx=hex color value
  54.   /Dname    Full path for disk swapping (implies /S1)
  55.   /Fname    Full path and filename of help file
  56.   /H,/?,?   Display this help screen
  57.   /Kxxyy    Change hotkey: xx=shift state(hex),
  58.             yy=scan code(hex)
  59.   /Lxx      Force number of rows on screen: xx=25,43,50
  60.   /M+,/M-   Display help text: on monochrome screen(+),
  61.             on default screen(-)
  62.   /Px       Pasting speed: 0=slow, 1=medium, 2=fast
  63.   /R        Send options to resident THELP
  64.   /Sx       Default Swapping Mode: 1=Use Disk, 2=Use EMS,
  65.             3=No Swapping
  66.   /U        Remove THELP from memory
  67.   /W        Write Options to THELP.COM and exit
  68.  
  69.  
  70. 3. Detailed Explanation of Keys Used When THELP is Active
  71. ---------------------------------------------------------
  72.  
  73.   Arrow keys:  Move the highlight from item to item within the
  74.                current help screen.
  75.  
  76.   PgUp/PgDn:   Move from screen to screen if additional screens
  77.                are available.
  78.  
  79.   ENTER:       Select help entry for the item highlighted in the
  80.                current help screen.
  81.  
  82.   ESC:         End Help.
  83.  
  84.   F1:          Help Index. F1 from any help screen brings up
  85.                the Help Index.
  86.  
  87.   ALT-F1:      Displays in reverse order the last 20 screens you
  88.                have reviewed.
  89.  
  90.   CTL-F1:      Bring up help screen for THELP's hot keys.
  91.  
  92.   F key:       Select new help file. 'F' or 'f' brings up a
  93.                window that allows you to change help files on
  94.            the fly. Type in the complete path name of the
  95.            new help file, and it will be read into memory
  96.            and initialized to the help index of the new file.
  97.                If the new file does not exist, or is in an
  98.            invalid format, THELP will beep twice, and return
  99.            you to the original file.
  100.  
  101.   J key:       Jump to specified help page number. 'J' or 'j'
  102.                brings up a window that allows you to jump to any
  103.                particular page (9999 max) in the help file. The
  104.                only editing key permitted in this window is
  105.                BackSpace. ESC aborts, CR (or four digits)
  106.                completes.
  107.  
  108.   K key:       Search help file for specified keyword. 'K' or 'k'
  109.                brings up a window in which you can enter a
  110.                keyword (40 characters max), and have THELP search
  111.                the help file for a match. If there is no matching
  112.                keyword in the current help file, THELP will beep
  113.                twice and return you to the original help screen.
  114.  
  115.   I key:       Paste highlighted keyword into application. 'I' or
  116.                'i' inserts the current highlighted keyword into
  117.                the keyboard buffer, and immediately pops down.
  118.  
  119.   P key:       Paste entire help screen into application. 'P' or
  120.                'p' inserts the entire current help page (as it
  121.                appears in the help window) into the current
  122.                application, and then immediately pops down.
  123.                Pasting can be interrupted with ^C or ^Break.
  124.  
  125.   S Key:       Save help screen to disk file (THELP.SAV). 'S' or
  126.                's' from any help screen saves the current help
  127.                page to the disk file THELP.SAV, in the current
  128.                directory. If the file already exists, the new
  129.                help information is appended to the end.
  130.  
  131.   <Hotkey Combo>
  132.                Pressing the hotkey combination when using THELP
  133.                on a second monitor ends this session of the
  134.                resident help, but leaves the current help screen
  135.                on the monochrome monitor.
  136.  
  137.  
  138. 4.  Detailed Explanation of Command-line Options
  139. ------------------------------------------------
  140.  
  141. /B       -- Use BIOS for video
  142.  
  143. This option forces THELP to use Interrupt 10h BIOS video calls
  144. for all writing to/reading from the video display. Normally, THELP
  145. will write directly to video RAM. Note that the use of this
  146. option negates the effect of the /M switch described below; the
  147. alternate monitor may not be used if /B is in effect. This option
  148. is enabled with '/B+', and disabled with '/B-' (enable is the
  149. default).
  150.  
  151. /C#xx     Select color: #=color number, xx=hex color value
  152.  
  153. There are eight possible colors, described as follows:
  154.  
  155.   1 = Color Normal Text
  156.   2 = Monochrome Normal Text
  157.   3 = Color Possible reference pages; top/bottom description line
  158.   4 = Monochrome Possible reference pages; top/bottom description line
  159.   5 = Color Border Color
  160.   6 = Monochrome Border Color
  161.   7 = Color Current Reference Selection
  162.   8 = Monochrome Current Reference Selection
  163.  
  164. Any or all of these eight colors may be specified on the command
  165. line.
  166.  
  167. The color numbers for a standard IBM-compatible Color Display are
  168. as follows:
  169.  
  170. First Digit (Background)              Second Digit (Foreground)
  171.  
  172. 0 -- Black                            0 -- Black
  173. 1 -- Blue                             1 -- Blue
  174. 2 -- Green                            2 -- Green
  175. 3 -- Cyan                             3 -- Cyan
  176. 4 -- Red                              4 -- Red
  177. 5 -- Magenta                          5 -- Magenta
  178. 6 -- Brown                            6 -- Brown
  179. 7 -- Grey                             7 -- Grey
  180.                                       8 -- Intense Black
  181.  ORing the color value with           9 -- Intense Blue
  182.  Hex 80 produces a blinking           A -- Intense Green
  183.  color unless blinking has been       B -- Intense Cyan
  184.  disabled.                            C -- Intense Red
  185.                                       D -- Intense Magenta
  186.                                       E -- Intense Brown (Yellow)
  187.                                       F -- Intense Grey (White)
  188.  
  189. On Monochrome monitors, the attribute values can differ widely,
  190. so some experimentation would be needed. Note that the monochrome
  191. attributes are used in only two cases; when the current video
  192. mode is 7, or when force mono is used (see the /M option)
  193.  
  194.  
  195. /Dname   -- Full path for disk swapping (implies /S1)
  196.  
  197. This option is used to override where THELP will place its swap
  198. files when swapping to disk. A full path should be specified,
  199. but a trailing '\' is not necessary. If no /D option is
  200. specified, under DOS 3.x swap files are placed in the directory
  201. where THELP.COM resides. Under DOS 2.x, swap files are placed by
  202. default in C:\.
  203.  
  204. Using this option also sets the flag that forces disk swapping
  205. instead of checking first for EMS.
  206.  
  207.  
  208. /Fname   -- Full path and filename of help file
  209.  
  210. The name that follows the /F option should be the full
  211. drive/directory pathname of the help file to use; e.g.,
  212.  
  213.     THELP /FC:\TP\TURBO.HLP
  214.     THELP /FC:\TURBOC\TCHELP.TCH
  215.  
  216. By default, THELP looks for the help file on the logged drive and
  217. directory.
  218.  
  219.  
  220. /H,/?,?  -- Display help screen
  221.  
  222. This option displays a summary of THELP's command-line options
  223.  
  224.  
  225. /Kxxyy   -- Change hotkey: xx=shift state, yy=scan code
  226.  
  227. Virtually any shift state/scan code combination may be selected.
  228. A quick summary of some common shift-states and scan codes
  229. follows:
  230.  
  231.  
  232.   Shift States (may be OR'ed together)
  233.  
  234.     right shift    01h
  235.     left shift     02h
  236.     control        04h
  237.     alt            08h
  238.  
  239.   Scan Codes
  240.  
  241.     A   --- 1eh     N   --- 31h     0   --- 0bh     F1  --- 3bh
  242.     B   --- 30h     O   --- 18h     1   --- 02h     F2  --- 3ch
  243.     C   --- 2eh     P   --- 19h     2   --- 03h     F3  --- 3dh
  244.     D   --- 20h     Q   --- 10h     3   --- 04h     F4  --- 3eh
  245.     E   --- 12h     R   --- 13h     4   --- 05h     F5  --- 3fh
  246.     F   --- 21h     S   --- 1fh     5   --- 06h     F6  --- 40h
  247.     G   --- 22h     T   --- 14h     6   --- 07h     F7  --- 41h
  248.     H   --- 23h     U   --- 16h     7   --- 08h     F8  --- 42h
  249.     I   --- 17h     V   --- 2fh     8   --- 09h     F9  --- 43h
  250.     J   --- 24h     W   --- 11h     9   --- 0ah     F10 --- 44h
  251.     K   --- 25h     X   --- 2dh
  252.     L   --- 26h     Y   --- 15h
  253.     M   --- 32h     Z   --- 2ch
  254.  
  255.  
  256.   Enhanced Keyboards only (may not work with all computers,
  257.   keyboards)
  258.  
  259.     F11 --- 57h
  260.     F12 --- 58h
  261.  
  262.  
  263. /Lxx     -- Force number of rows on screen: xx=25,43,50
  264.  
  265. Some video adapters do not correctly store the number of video
  266. rows on the screen in the BIOS data location specified for the
  267. IBM-PC. This option forces THELP to use the given value, rather
  268. than the number the BIOS reports.
  269.  
  270.  
  271. /M+,/M-  -- Display help text: on monochrome screen(+),
  272.             on default screen(-)
  273.  
  274. For users with dual-monitor systems, this option may be used to
  275. instruct THELP to bring up its display on the monochrome monitor,
  276. rather than on the color monitor. This option is enabled with
  277. '/M+', and disabled with '/M-' (enable is the default). Note that
  278. /M is incompatible with /B (see above).
  279.  
  280.  
  281. /Px      -- Pasting speed: 0=slow, 1=medium, 2=fast
  282.  
  283. Some editors do not accept characters pasted into the keyboard
  284. buffer as fast as THELP can put them there. By setting an
  285. appropriate paste speed, virtually all possible configurations of
  286. editors may be used. FAST speed pastes as many characters as will
  287. fit on every timer tick; MEDIUM pastes up to four characters per
  288. tick; and SLOW pastes a single character into the buffer ONLY
  289. when the buffer is empty.
  290.  
  291.  
  292. /R       -- Send options to resident THELP
  293.  
  294. The /R option is used to pass parameters (like new colors, or new
  295. hotkeys) to the resident portion of THELP. All THELP command line
  296. options may be sent to the resident portion except for the
  297. swapping mode, which cannot be modified once THELP has been
  298. initialized.
  299.  
  300. In combination with these options, you can create a batch file
  301. that changes THELP's configuration as you change editors; i.e.:
  302.  
  303.   THELP /M /P0 /FC:\TP\TURBO.HLP /R
  304.     Use mono monitor, slow pasting, and the Turbo Pascal help
  305.     file. Options are not saved to disk.
  306.  
  307.   THELP /P2 /FC:\TC\TCHELP.TCH /R
  308.     Use default monitor, fast pasting, and the Turbo C help file.
  309.     Options are not saved to disk.
  310.  
  311.  
  312. /Sx      -- Default Swapping Mode: 1=Use Disk, 2=Use EMS,
  313.             3=No Swapping
  314.  
  315. If no '/S' parameter is used, THELP first tests to see if
  316. Expanded Memory is available in the system. If so, and if enough
  317. memory can be allocated, swapping is done to EMS. If EMS is not
  318. available, disk swapping is used. See the /D parameter for
  319. information on where the swap file will be written if disk
  320. swapping is used.
  321.  
  322.  
  323. /U       -- Remove THELP from memory
  324.  
  325. This option is used to remove THELP from memory. If other TSRs
  326. have been loaded after THELP, make sure to remove them before
  327. removing THELP.
  328.  
  329.  
  330. /W       -- Write Options to THELP.COM and exit
  331.  
  332. The /W parameter is used to create a new version of THELP that
  333. uses the options you desire as a default. All options, including
  334. /S (but not /R) may be specified and made 'permanent'.
  335.